<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SoupRequester</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libsoup Reference Manual">
<link rel="up" href="ch07.html" title="Experimental streaming API">
<link rel="prev" href="ch07.html" title="Experimental streaming API">
<link rel="next" href="SoupRequest.html" title="SoupRequest">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch07.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch07.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libsoup Reference Manual</th>
<td><a accesskey="n" href="SoupRequest.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#SoupRequester.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#SoupRequester.description" class="shortcut">Description</a>
                   | 
                  <a href="#SoupRequester.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#SoupRequester.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
</td></tr>
</table>
<div class="refentry">
<a name="SoupRequester"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="SoupRequester.top_of_page"></a>SoupRequester</span></h2>
<p>SoupRequester</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="SoupRequester.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libsoup/soup.h&gt;

struct              <a class="link" href="SoupRequester.html#SoupRequester-struct" title="struct SoupRequester">SoupRequester</a>;
<a class="link" href="SoupRequester.html" title="SoupRequester"><span class="returnvalue">SoupRequester</span></a> *     <a class="link" href="SoupRequester.html#soup-requester-new" title="soup_requester_new ()">soup_requester_new</a>                  (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="SoupRequest.html" title="SoupRequest"><span class="returnvalue">SoupRequest</span></a> *       <a class="link" href="SoupRequester.html#soup-requester-request" title="soup_requester_request ()">soup_requester_request</a>              (<em class="parameter"><code><a class="link" href="SoupRequester.html" title="SoupRequester"><span class="type">SoupRequester</span></a> *requester</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *uri_string</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a class="link" href="SoupRequest.html" title="SoupRequest"><span class="returnvalue">SoupRequest</span></a> *       <a class="link" href="SoupRequester.html#soup-requester-request-uri" title="soup_requester_request_uri ()">soup_requester_request_uri</a>          (<em class="parameter"><code><a class="link" href="SoupRequester.html" title="SoupRequester"><span class="type">SoupRequester</span></a> *requester</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);

enum                <a class="link" href="SoupRequester.html#SoupRequesterError" title="enum SoupRequesterError">SoupRequesterError</a>;
#define             <a class="link" href="SoupRequester.html#SOUP-REQUESTER-ERROR:CAPS" title="SOUP_REQUESTER_ERROR">SOUP_REQUESTER_ERROR</a>
</pre>
</div>
<div class="refsect1">
<a name="SoupRequester.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----SoupRequester
</pre>
</div>
<div class="refsect1">
<a name="SoupRequester.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
SoupRequester implements
 <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature">SoupSessionFeature</a>.</p>
</div>
<div class="refsect1">
<a name="SoupRequester.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="SoupRequester.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="SoupRequester-struct"></a><h3>struct SoupRequester</h3>
<pre class="programlisting">struct SoupRequester;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-requester-new"></a><h3>soup_requester_new ()</h3>
<pre class="programlisting"><a class="link" href="SoupRequester.html" title="SoupRequester"><span class="returnvalue">SoupRequester</span></a> *     soup_requester_new                  (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new <a class="link" href="SoupRequester.html" title="SoupRequester"><span class="type">SoupRequester</span></a> object, which can be added to
a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> with <a class="link" href="SoupSession.html#soup-session-add-feature" title="soup_session_add_feature ()"><code class="function">soup_session_add_feature()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new <a class="link" href="SoupRequester.html" title="SoupRequester"><span class="type">SoupRequester</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.34</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-requester-request"></a><h3>soup_requester_request ()</h3>
<pre class="programlisting"><a class="link" href="SoupRequest.html" title="SoupRequest"><span class="returnvalue">SoupRequest</span></a> *       soup_requester_request              (<em class="parameter"><code><a class="link" href="SoupRequester.html" title="SoupRequester"><span class="type">SoupRequester</span></a> *requester</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *uri_string</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Creates a <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> for retrieving <em class="parameter"><code>uri_string</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>requester</code></em> :</span></p></td>
<td>a <a class="link" href="SoupRequester.html" title="SoupRequester"><span class="type">SoupRequester</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri_string</code></em> :</span></p></td>
<td>a URI, in string form</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a>, or
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.34</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-requester-request-uri"></a><h3>soup_requester_request_uri ()</h3>
<pre class="programlisting"><a class="link" href="SoupRequest.html" title="SoupRequest"><span class="returnvalue">SoupRequest</span></a> *       soup_requester_request_uri          (<em class="parameter"><code><a class="link" href="SoupRequester.html" title="SoupRequester"><span class="type">SoupRequester</span></a> *requester</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Creates a <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> for retrieving <em class="parameter"><code>uri</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>requester</code></em> :</span></p></td>
<td>a <a class="link" href="SoupRequester.html" title="SoupRequester"><span class="type">SoupRequester</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> representing the URI to retrieve</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a>, or
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.34</p>
</div>
<hr>
<div class="refsect2">
<a name="SoupRequesterError"></a><h3>enum SoupRequesterError</h3>
<pre class="programlisting">typedef enum {
	SOUP_REQUESTER_ERROR_BAD_URI,
	SOUP_REQUESTER_ERROR_UNSUPPORTED_URI_SCHEME
} SoupRequesterError;
</pre>
<p>
A <a class="link" href="SoupRequester.html" title="SoupRequester"><span class="type">SoupRequester</span></a> error.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="SOUP-REQUESTER-ERROR-BAD-URI:CAPS"></a><span class="term"><code class="literal">SOUP_REQUESTER_ERROR_BAD_URI</code></span></p></td>
<td>the URI could not be parsed
</td>
</tr>
<tr>
<td><p><a name="SOUP-REQUESTER-ERROR-UNSUPPORTED-URI-SCHEME:CAPS"></a><span class="term"><code class="literal">SOUP_REQUESTER_ERROR_UNSUPPORTED_URI_SCHEME</code></span></p></td>
<td>the URI scheme is not
  supported by this <a class="link" href="SoupRequester.html" title="SoupRequester"><span class="type">SoupRequester</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.34</p>
</div>
<hr>
<div class="refsect2">
<a name="SOUP-REQUESTER-ERROR:CAPS"></a><h3>SOUP_REQUESTER_ERROR</h3>
<pre class="programlisting">#define SOUP_REQUESTER_ERROR soup_requester_error_quark ()
</pre>
<p>
A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> domain for <a class="link" href="SoupRequester.html" title="SoupRequester"><span class="type">SoupRequester</span></a> errors. Used with
<a class="link" href="SoupRequester.html#SoupRequesterError" title="enum SoupRequesterError"><span class="type">SoupRequesterError</span></a>.
</p>
<p class="since">Since 2.34</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>